get /tasks/{taskId}
Describe Task (getTask)
Returns a description of a Velostrata management task.
Path parameters
taskId (required)
Path Parameter — Task ID
Consumes
This API call consumes the following media types via the Content-Type request header:
- application/json
Return type
TaskDescription
Velostrata management task description
|
additionalInfo (optional) |
StringToObjectMap |
||||||
|
endTime (optional) |
Date Time task ended format: date-time |
||||||
|
entity (optional) |
EntityId
|
||||||
|
errorDetails (optional) |
String Task error details |
||||||
|
errorMessage (optional) |
array[String] Task error messages |
||||||
|
id (optional) |
TaskId
|
||||||
|
onPremisesTaskId (optional) |
String On-premises task ID |
||||||
|
parentTaskId (optional) |
TaskId
|
||||||
|
progress (optional) |
Integer Task progress format: int32 |
||||||
|
progressMessage (optional) |
array[String] Progress message |
||||||
|
startTime (optional) |
Date Start time of the task format: date-time |
||||||
|
state (optional) |
TaskState State of the task - Running, Failed, Cancelled, Succeeded, Failing or Cancelling |
||||||
|
subTasks (optional) |
array[TaskId] Sub tasks |
||||||
|
taskType (optional) |
TaskType Task type, for example, CreateCloudExtension and RunVmInCloud |
||||||
|
username (optional) |
String User name |
Example data
Content-Type: application/json
{
"endTime": "2017-06-14T23:02:43.269Z",
"entity": {
"value": "vm-1",
"_type": "VmId"
},
"errorDetails": "string",
"errorMessage": [
"string"
],
"id": {
"value": "vm-1",
"_type": "TaskId"
},
"onPremisesTaskId": "task-123",
"parentTaskId": {
"value": "vm-1",
"_type": "TaskId"
},
"progress": 0,
"progressMessage": [
"string"
],
"startTime": "2017-06-14T23:02:43.269Z",
"state": "Running",
"subTasks": [
{
"value": "vm-1",
"_type": "TaskId"
}
],
"taskType": "RunVmInCloud",
"username": "velostrata_vcenetr_user"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
- application/json
Responses
200
OK TaskDescription
Default
Error ErrorInfo
|
errorCode (optional) |
String |
|
url(optional) |
String |
|
message (optional) |
String |